vcOneToManyInterface
vcOneToManyInterface is a behavior used for connecting a component to one or more components. This class supports multiple connections at the same time, but only a single "template" section can be defined.
See in: Overview
Module: vcBehaviors
Parent: vcSimInterface
Children -
Referenced by: -
Properties
Learn how to use properties here. The properties are also inherited from the parent class.
| Name | Type | Access | Description |
| ConnectedComponents | vcList[vcComponent] | R | Gets a list of all components connected to this interface.See moreEach component appears only once in the list even if multiple connections exist. Exceptions: RuntimeError: When the owning component hasn't been initialized. |
| Sections | vcList[vcSimInterfaceSection] | R | Gets a list of all sections in this interface. |
Methods
Learn how to use methods here. The methods are also inherited from the parent class.
| Name | Return Type | Parameters | Description |
| createSection | vcSimInterfaceSection | String sectionName | Sections can't be created into one to many interface. Exceptions: RuntimeError: Always. |
| disconnect | Boolean | Optional Keyword[otherInterface = vcSimInterface] | Removes either all or a specific connection from this interface.See moreParameters: Optional: otherInterface (vcSimInterface): Specific interface from which to disconnect. If not provided, all connections will be removed. Returns: bool: True when disconnection was successful, False otherwise. Exceptions: RuntimeError: Occurs when simulation node hierarchy is locked. |